Sourced from redis's releases.

5.1.0

Changes

🚀 New Features

• Client-side caching (#3350, #3110, #3102, #3099, #3089, #3038)

How to start with Client-side caching?

1. Install redis-py 5.1.0
2. Use the following code snippet:

r = Redis(protocol=3, cache_config=CacheConfig())
cache = r.get_cache()
r.set("foo", "bar")
get key from redis and save in local cache
print(r.get("foo"))
get key from local cache
print(cache.get(CacheKey(command="GET", redis_keys=("foo",))).cache_value)
change key in redis (cause invalidation)
r.set("foo", "barbar")
Retrieves a new value from server and cache it
print(r.get("foo"))
Make sure that new value was cached
print(cache.get(CacheKey(command="GET", redis_keys=("foo",))).cache_value)

Check documentation to get more examples

🔥 Breaking Changes

• Timeseries insertion filters for close samples (#3228)
• Enhanced classes string representation (#3001)
• Partial clean up of Python 3.7 compatibility (#2928)
• Handle RESP3 sets as Python lists (#3324)

🐛 Bug Fixes

• Handle RESP3 sets as Python lists (#3324)
• Prevent async ClusterPipeline instances from becoming "false-y" (#3068)
• Add hostname field to _parse_node_line (#3343)
• More docs fixes (#3326)
• Delete the first-defined (and thus "duplicate") Script class (#3333)
• Catch a known DeprecationWarning when calling .close() (#3335)
• Add missed redismod at test_commands.py (#3369)

🧰 Maintenance

• Update README.md - mentioning redis 7.4 support (#3375)
• Update PyPy 3.8 to 3.10 in CI (#3370)
• Updated commands from docker-compose to docker compose (#3352)

... (truncated)

Sourced from redis's changelog.

* Move doctests (doc code examples) to main branch
* Update `ResponseT` type hint
* Allow to control the minimum SSL version
* Add an optional lock_name attribute to LockError.
* Fix return types for `get`, `set_path` and `strappend` in JSONCommands
* Connection.register_connect_callback() is made public.
* Fix async `read_response` to use `disable_decoding`.
* Add 'aclose()' methods to async classes, deprecate async close().
* Fix [#2831](https://github.com/redis/redis-py/issues/2831), add auto_close_connection_pool=True arg to asyncio.Redis.from_url()
* Fix incorrect redis.asyncio.Cluster type hint for `retry_on_error`
* Fix dead weakref in sentinel connection causing ReferenceError ([#2767](https://github.com/redis/redis-py/issues/2767))
* Fix [#2768](https://github.com/redis/redis-py/issues/2768), Fix KeyError: 'first-entry' in parse_xinfo_stream.
* Fix [#2749](https://github.com/redis/redis-py/issues/2749), remove unnecessary __del__ logic to close connections.
* Fix [#2754](https://github.com/redis/redis-py/issues/2754), adding a missing argument to SentinelManagedConnection
* Fix `xadd` command to accept non-negative `maxlen` including 0
* Revert [#2104](https://github.com/redis/redis-py/issues/2104), [#2673](https://github.com/redis/redis-py/issues/2673), add `disconnect_on_error` option to `read_response()` (issues [#2506](https://github.com/redis/redis-py/issues/2506), [#2624](https://github.com/redis/redis-py/issues/2624))
* Add `address_remap` parameter to `RedisCluster`
* Fix incorrect usage of once flag in async Sentinel
* asyncio: Fix memory leak caused by hiredis ([#2693](https://github.com/redis/redis-py/issues/2693))
* Allow data to drain from async PythonParser when reading during a disconnect()
* Use asyncio.timeout() instead of async_timeout.timeout() for python >= 3.11 ([#2602](https://github.com/redis/redis-py/issues/2602))
* Add a Dependabot configuration to auto-update GitHub action versions.
* Add test and fix async HiredisParser when reading during a disconnect() ([#2349](https://github.com/redis/redis-py/issues/2349))
* Use hiredis-py pack_command if available.
* Support `.unlink()` in ClusterPipeline
* Simplify synchronous SocketBuffer state management
* Fix string cleanse in Redis Graph
* Make PythonParser resumable in case of error ([#2510](https://github.com/redis/redis-py/issues/2510))
* Add `timeout=None` in `SentinelConnectionManager.read_response`
* Documentation fix: password protected socket connection ([#2374](https://github.com/redis/redis-py/issues/2374))
* Allow `timeout=None` in `PubSub.get_message()` to wait forever
* add `nowait` flag to `asyncio.Connection.disconnect()`
* Update README.md links
* Fix timezone handling for datetime to unixtime conversions
* Fix start_id type for XAUTOCLAIM
* Remove verbose logging from cluster.py
* Add retry mechanism to async version of Connection
* Compare commands case-insensitively in the asyncio command parser
* Allow negative `retries` for `Retry` class to retry forever
* Add `items` parameter to `hset` signature
* Create codeql-analysis.yml ([#1988](https://github.com/redis/redis-py/issues/1988)). Thanks @chayim
* Add limited support for Lua scripting with RedisCluster
* Implement `.lock()` method on RedisCluster
* Fix cursor returned by SCAN for RedisCluster & change default target to PRIMARIES
* Fix scan_iter for RedisCluster
* Remove verbose logging when initializing ClusterPubSub, ClusterPipeline or RedisCluster
* Fix broken connection writer lock-up for asyncio ([#2065](https://github.com/redis/redis-py/issues/2065))
* Fix auth bug when provided with no username ([#2086](https://github.com/redis/redis-py/issues/2086))
* Fix missing ClusterPipeline._lock ([#2189](https://github.com/redis/redis-py/issues/2189))
* Added dynaminc_startup_nodes configuration to RedisCluster

... (truncated)

• 7215a52 Updated package version (#3389)
• 2e46613 Client side caching refactoring (#3350)
• 7d73d74 DOC-4197: add TCEs to the geospatial query page (#3378)
• c7483b3 DOC-4196: add TCEs to the full-text query page (#3377)
• 64d4bb8 DOC-4194: add TCEs to the range query page (#3374)
• 0c8a986 DOC-4194: add TCEs to the exact match query page (#3372)
• cbb129d Update README.md - mentioning redis 7.4 support (#3375)
• 2fb40c1 TCEs for select command pages (#3361)
• e00f3d2 Add missed redismod at test_commands.py (#3369)
• 6c94faa Update PyPy 3.8 to 3.10 in CI (#3370)
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)